<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>XenC: XenFile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XenC
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Open-source tool for data selection in NLP</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_xen_file-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XenFile Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class providing some basic functions around files.  
 <a href="class_xen_file.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="xenfile_8h_source.html">xenfile.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae46bf649d5ea8c9a35d5880d908d9ae2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#ae46bf649d5ea8c9a35d5880d908d9ae2">XenFile</a> ()</td></tr>
<tr class="memdesc:ae46bf649d5ea8c9a35d5880d908d9ae2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ae46bf649d5ea8c9a35d5880d908d9ae2">More...</a><br /></td></tr>
<tr class="separator:ae46bf649d5ea8c9a35d5880d908d9ae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c4abd164088301040277a9a2345466"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a67c4abd164088301040277a9a2345466">initialize</a> (std::string name)</td></tr>
<tr class="memdesc:a67c4abd164088301040277a9a2345466"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization function from a string.  <a href="#a67c4abd164088301040277a9a2345466">More...</a><br /></td></tr>
<tr class="separator:a67c4abd164088301040277a9a2345466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a183728bf388b5f1a8c5f5aae039c37b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a183728bf388b5f1a8c5f5aae039c37b7">~XenFile</a> ()</td></tr>
<tr class="memdesc:a183728bf388b5f1a8c5f5aae039c37b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a183728bf388b5f1a8c5f5aae039c37b7">More...</a><br /></td></tr>
<tr class="separator:a183728bf388b5f1a8c5f5aae039c37b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a497bf6ae8ffb922e79ce5022a688636e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a497bf6ae8ffb922e79ce5022a688636e">getFileName</a> () const </td></tr>
<tr class="memdesc:a497bf6ae8ffb922e79ce5022a688636e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the file name.  <a href="#a497bf6ae8ffb922e79ce5022a688636e">More...</a><br /></td></tr>
<tr class="separator:a497bf6ae8ffb922e79ce5022a688636e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1974bdce684709c880b2e11c8592660"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#ae1974bdce684709c880b2e11c8592660">getPrefix</a> ()</td></tr>
<tr class="memdesc:ae1974bdce684709c880b2e11c8592660"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the prefix of the file name (before the dot)  <a href="#ae1974bdce684709c880b2e11c8592660">More...</a><br /></td></tr>
<tr class="separator:ae1974bdce684709c880b2e11c8592660"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38a855c54140058820b4bd7cd770b245"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a38a855c54140058820b4bd7cd770b245">getExt</a> ()</td></tr>
<tr class="memdesc:a38a855c54140058820b4bd7cd770b245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the extension of the file name (after the dot)  <a href="#a38a855c54140058820b4bd7cd770b245">More...</a><br /></td></tr>
<tr class="separator:a38a855c54140058820b4bd7cd770b245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a020f2d5cee6e7546e6df382d464e68d8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a020f2d5cee6e7546e6df382d464e68d8">getDirName</a> () const </td></tr>
<tr class="memdesc:a020f2d5cee6e7546e6df382d464e68d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the file's directory name.  <a href="#a020f2d5cee6e7546e6df382d464e68d8">More...</a><br /></td></tr>
<tr class="separator:a020f2d5cee6e7546e6df382d464e68d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14321a000f5284d9c52d9f304e116f95"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a14321a000f5284d9c52d9f304e116f95">getFullPath</a> () const </td></tr>
<tr class="memdesc:a14321a000f5284d9c52d9f304e116f95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the file's full path.  <a href="#a14321a000f5284d9c52d9f304e116f95">More...</a><br /></td></tr>
<tr class="separator:a14321a000f5284d9c52d9f304e116f95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57e9fb73fab86706fac712aa3d86ad2d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_file.html#a57e9fb73fab86706fac712aa3d86ad2d">isGZ</a> () const </td></tr>
<tr class="memdesc:a57e9fb73fab86706fac712aa3d86ad2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to guess if the file is a gzip or plain text.  <a href="#a57e9fb73fab86706fac712aa3d86ad2d">More...</a><br /></td></tr>
<tr class="separator:a57e9fb73fab86706fac712aa3d86ad2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class providing some basic functions around files. </p>
<p>This class handles the files used in XenC and provides some basic functionalities around them used widely in XenC. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae46bf649d5ea8c9a35d5880d908d9ae2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XenFile::XenFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="a183728bf388b5f1a8c5f5aae039c37b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XenFile::~XenFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a020f2d5cee6e7546e6df382d464e68d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string XenFile::getDirName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the file's directory name. </p>
<dl class="section return"><dt>Returns</dt><dd>the file's directory name </dd></dl>

</div>
</div>
<a class="anchor" id="a38a855c54140058820b4bd7cd770b245"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string XenFile::getExt </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the extension of the file name (after the dot) </p>
<dl class="section return"><dt>Returns</dt><dd>the file name's extension </dd></dl>

</div>
</div>
<a class="anchor" id="a497bf6ae8ffb922e79ce5022a688636e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string XenFile::getFileName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the file name. </p>
<dl class="section return"><dt>Returns</dt><dd>the file name (and only the file name) </dd></dl>

</div>
</div>
<a class="anchor" id="a14321a000f5284d9c52d9f304e116f95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string XenFile::getFullPath </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the file's full path. </p>
<dl class="section return"><dt>Returns</dt><dd>the file's full path </dd></dl>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_xen_file_a14321a000f5284d9c52d9f304e116f95_icgraph.png" border="0" usemap="#class_xen_file_a14321a000f5284d9c52d9f304e116f95_icgraph" alt=""/></div>
<map name="class_xen_file_a14321a000f5284d9c52d9f304e116f95_icgraph" id="class_xen_file_a14321a000f5284d9c52d9f304e116f95_icgraph">
<area shape="rect" id="node2" href="class_xen_file.html#a57e9fb73fab86706fac712aa3d86ad2d" title="Tries to guess if the file is a gzip or plain text. " alt="" coords="195,5,297,31"/>
</map>
</div>
</p>

</div>
</div>
<a class="anchor" id="ae1974bdce684709c880b2e11c8592660"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string XenFile::getPrefix </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the prefix of the file name (before the dot) </p>
<dl class="section return"><dt>Returns</dt><dd>the file name's prefix </dd></dl>

</div>
</div>
<a class="anchor" id="a67c4abd164088301040277a9a2345466"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XenFile::initialize </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization function from a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>: the file to handle </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a57e9fb73fab86706fac712aa3d86ad2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool XenFile::isGZ </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tries to guess if the file is a gzip or plain text. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the file is gzipped </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_xen_file_a57e9fb73fab86706fac712aa3d86ad2d_cgraph.png" border="0" usemap="#class_xen_file_a57e9fb73fab86706fac712aa3d86ad2d_cgraph" alt=""/></div>
<map name="class_xen_file_a57e9fb73fab86706fac712aa3d86ad2d_cgraph" id="class_xen_file_a57e9fb73fab86706fac712aa3d86ad2d_cgraph">
<area shape="rect" id="node2" href="class_xen_file.html#a14321a000f5284d9c52d9f304e116f95" title="Accessor to the file&#39;s full path. " alt="" coords="155,5,297,31"/>
</map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="xenfile_8h_source.html">xenfile.h</a></li>
<li>src/<a class="el" href="xenfile_8cpp.html">xenfile.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 18 2016 17:22:37 for XenC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
